Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/ValidationBackedNumberFieldWidget

ValidationBackedNumberFieldWidget

open class ValidationBackedNumberFieldWidget<T : Number>(width: Int, height: Int, wrappedValue: Supplier<T>, choiceValidator: ChoiceValidator<T>, validationProvider: Function<Double, ValidationResult<T>>, applier: Consumer<T> = Consumer { _ ->}, renderStatus: Boolean = true, increment: Double = 0.0) : TextFieldWidget, TooltipChild

A TextFieldWidget for entering number values, backed by validation of some sort.

Author

fzzyhmstrs

Since

0.2.0

Parameters

extends Number

width

Int - width of the text field

height

Int - height of the text field

wrappedValue

Supplier - supplier of the value to display on the text field. This is separate from any values stored within the widget, and generally is the same source as the applier, so this widget is updated if any external changes are made to the number

choiceValidator

ChoiceValidator - additional choice validation, if any. Generally this can be ChoiceValidator.any

validationProvider

FunctionValidationResult> - validates the number entered. all numbers entered are treated as doubles internally until application.

applier

Consumer - accepts results from valid user entries

Constructors

ValidationBackedNumberFieldWidget

constructor(width: Int, height: Int, wrappedValue: Supplier<T>, choiceValidator: ChoiceValidator<T>, validationProvider: Function<Double, ValidationResult<T>>, applier: Consumer<T> = Consumer { _ ->}, renderStatus: Boolean = true, increment: Double = 0.0)

Properties

var active: Boolean

var focused: Boolean

var message: Text

var navigationOrder: Int

text

var text: String

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendClickableNarrations

open override fun appendClickableNarrations(builder: NarrationMessageBuilder)

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

appendValueNarrations

fun appendValueNarrations(builder: NarrationMessageBuilder)

charTyped

open override fun charTyped(chr: Char, modifiers: Int): Boolean

drawsBackground

open fun drawsBackground(): Boolean

eraseCharacters

open fun eraseCharacters(characterOffset: Int)

eraseCharactersTo

open fun eraseCharactersTo(position: Int)

eraseWords

open fun eraseWords(wordOffset: Int)

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getCharacterX

open fun getCharacterX(index: Int): Int

getCursor

open fun getCursor(): Int

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getRight

open fun getRight(): Int

getSelectedText

open fun getSelectedText(): String

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

getWordSkipPosition

open fun getWordSkipPosition(wordOffset: Int): Int

isActive

open fun isActive(): Boolean

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

isVisible

open fun isVisible(): Boolean

keyPressed

open override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

moveCursor

open fun moveCursor(offset: Int, shiftKeyPressed: Boolean)

onClick

open override fun onClick(mouseX: Double, mouseY: Double)

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open override fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open override fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render